CuDoubleSidedScannerAPI  1.11
Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI Class Reference

Factory class to manage scanner library APIs More...

Public Member Functions

 CuDoubleSidedScannerAPI ()
 
 CuDoubleSidedScannerAPI (LogSetting logSettings)
 
String GetAPIVersion ()
 Returns current API version More...
 
String GetAPIVersionHwLibrary ()
 Gets the API release for hardware library (C-library) More...
 
String [] EnumScanner ()
 Enumerates all online scanners. More...
 
CuScanner ConnectScanner (String scannerDeviceUSBDeclaration)
 Creates a scanner connection and creates the related CuScanner object that will be used by the calling application for all the following scanner communication. More...
 
void Disconnect (CuScanner scan)
 Unloads the CuScanner object. Call this function when scanner communication is not needed anymore. More...
 

Detailed Description

Factory class to manage scanner library APIs

Constructor & Destructor Documentation

◆ CuDoubleSidedScannerAPI() [1/2]

Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.CuDoubleSidedScannerAPI ( )
inline

Costructor. Use the default log verbosity level and settings

◆ CuDoubleSidedScannerAPI() [2/2]

Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.CuDoubleSidedScannerAPI ( LogSetting  logSettings)
inline

Costructor. Also specify log verbosity level and other settings.

Parameters
logSettingsVerbosity log level and settings.

Member Function Documentation

◆ ConnectScanner()

CuScanner Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.ConnectScanner ( String  scannerDeviceUSBDeclaration)
inline

Creates a scanner connection and creates the related CuScanner object that will be used by the calling application for all the following scanner communication.

Parameters
scannerDeviceUSBDeclarationScanner USB declaration formatted in the following way: "VID|PID|SN", where VID is vendor ID, PID is product ID and SN is the USB serial number.
scannerDeviceUSBDeclaration is one element of the string array returned by EnumScanner.
Returns
CuScanner object to be used for all scanner communications.
Exceptions
CuDoubleSidedScannerExceptionif an error occurred.

◆ Disconnect()

void Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.Disconnect ( CuScanner  scan)
inline

Unloads the CuScanner object. Call this function when scanner communication is not needed anymore.

Parameters
scanCuScanner object to be unload.
Exceptions
CuDoubleSidedScannerException

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.ConnectScanner().

◆ EnumScanner()

String [] Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.EnumScanner ( )
inline

Enumerates all online scanners.

Returns
An array of strings, containig data about each scanner device. Each string contains data formatted in this way: VID|PID|SN, where VID is vendor ID, PID is product ID and SN is the USB serial number. If no scanner is online, returns an empty array.
Exceptions
CuDoubleSidedScannerExceptionif an error occurred.

◆ GetAPIVersion()

String Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.GetAPIVersion ( )
inline

Returns current API version

Returns
A string containing the current API version
Exceptions
CuDoubleSidedScannerException

◆ GetAPIVersionHwLibrary()

String Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerAPI.GetAPIVersionHwLibrary ( )
inline

Gets the API release for hardware library (C-library)

Returns
A String containing the hardware library (C-library) release
Exceptions
CuDoubleSidedScannerException